/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/main/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at legal/OPEN-SOURCE-LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * SecurityConstraintNode.java
 *
 * Created on March 1, 2002, 2:24 PM
 */

package org.glassfish.web.deployment.node;

import com.sun.enterprise.deployment.node.DeploymentDescriptorNode;
import com.sun.enterprise.deployment.node.XMLElement;
import com.sun.enterprise.deployment.web.WebResourceCollection;
import org.glassfish.web.deployment.descriptor.*;
import org.glassfish.web.deployment.xml.WebTagNames;
import org.w3c.dom.Node;

import java.util.Enumeration;
import java.util.Map;

/** 
 * This node handles the security-contraint xml tag
 *
 * @author  Jerome Dochez
 * @version 
 */
public class SecurityConstraintNode extends DeploymentDescriptorNode<SecurityConstraintImpl> {

    public SecurityConstraintNode() {
        super();
        registerElementHandler(new XMLElement(WebTagNames.USERDATA_CONSTRAINT), 
                    UserDataConstraintNode.class, "setUserDataConstraint");
        registerElementHandler(new XMLElement(WebTagNames.AUTH_CONSTRAINT),         
                    AuthConstraintNode.class, "setAuthorizationConstraint");
        registerElementHandler(new XMLElement(WebTagNames.WEB_RESOURCE_COLLECTION),         
                    WebResourceCollectionNode.class, "addWebResourceCollection");        
    }

    protected SecurityConstraintImpl descriptor = null;

    /**
     * @return the descriptor instance to associate with this XMLNode
     */
    @Override
    public SecurityConstraintImpl getDescriptor() {
        if (descriptor==null) {
            descriptor = new SecurityConstraintImpl();
        }
        return descriptor;
    }

    /**
     * all sub-implementation of this class can use a dispatch table to map 
     * xml element to
     * method name on the descriptor class for setting the element value. 
     *  
     * @return the map with the element name as a key, the setter method as a 
     * value
     */
    @Override
    protected Map<String, String> getDispatchTable() {    
        Map<String, String> table = super.getDispatchTable();
        table.put(WebTagNames.NAME, "setName");
	return table;
    }
    
    /**
     * write the descriptor class to a DOM tree and return it
     *
     * @param parent node in the DOM tree 
     * @param nodeName node name for the root element of this xml fragment
     * @param descriptor the descriptor to write
     * @return the DOM tree top node
     */
    @Override
    public Node writeDescriptor(Node parent, String nodeName, SecurityConstraintImpl descriptor) {
        Node myNode = appendChild(parent, nodeName);
        appendTextChild(myNode, WebTagNames.NAME, descriptor.getName());
        
        // web-resource-collection+
        WebResourceCollectionNode wrcNode = new WebResourceCollectionNode();
        for (WebResourceCollection webResource: descriptor.getWebResourceCollections()) {
                wrcNode.writeDescriptor(myNode, WebTagNames.WEB_RESOURCE_COLLECTION,
                    (WebResourceCollectionImpl) webResource);
        }
        
        // auth-constaint?
        AuthorizationConstraintImpl aci = (AuthorizationConstraintImpl) descriptor.getAuthorizationConstraint();
        if (aci!=null) {
            AuthConstraintNode acNode = new AuthConstraintNode();
            acNode.writeDescriptor(myNode, WebTagNames.AUTH_CONSTRAINT, aci);
        }
        
        // user-data-constraint?
        UserDataConstraintImpl udci = (UserDataConstraintImpl) descriptor.getUserDataConstraint();
        if (udci!=null) {
            UserDataConstraintNode udcn = new UserDataConstraintNode();
            udcn.writeDescriptor(myNode, WebTagNames.USERDATA_CONSTRAINT, udci);
        }
        return myNode;        
    }
    
}
